home *** CD-ROM | disk | FTP | other *** search
/ MacFormat 1995 March / macformat-022.iso / Shareware City / Comms / File Search Engine 1.3 folder / File Search Engine 1.3 / How to use •File Search Engine < prev   
Encoding:
Text File  |  1994-08-28  |  8.9 KB  |  169 lines  |  [TEXT/McSk]

  1. Version 1.3 of File Search Engine is released as a fully functional ShareWare program. The ShareWare fee is only $12.50.
  2.  
  3. After 2 weeks evaluation, please send your ShareWare payment of $12.50 to:
  4.  
  5. Glen Stewart
  6. The Association Mac BBS, 810-695-6955
  7. 1434 Rollins
  8. Grand Blanc, MI 48439
  9.  
  10. Questions and comments are always welcome!  Netmail to 1:2240/174 or via the
  11. internet at glen.stewart@f174.n2240.z1.ieee.org
  12.  
  13.  
  14. What File Search Engine does...
  15. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16. The search engine is a continuously-running application that runs right along with all your other
  17. Telefinder programs.  The engine checks 3 particular folders once every 5 seconds to see if a search
  18. request is waiting - a special e-mail or netmail request from a user.  If the request exists, File
  19. Search Engine opens a). your BBS's files listing, created by Itsy SitC Citer, and scans for files
  20. which match the search criteria or b). Webster's Bible, and scans for any verses that match the
  21. search criteria or c). the current FidoNet nodelist for any entries that match the given search
  22. strings.  A reply is sent in less than one minute per 1Mb of text to the requesting user (25Mhz '030
  23. cpu).
  24.  
  25. CPU load for file description searches is regulated by the length (number of files and length of
  26. their descriptions) in each of your directory paths.  For Bible and nodelist searches, the CPU load
  27. is higher (hey, it's a big book!) and dependant on the size of each book.  On multi-node BBS's, the
  28. engine allows users to browse the BBS after submitting a request without dragging the whole BBS down.
  29. Users on other nodes might see data coming in 'bursts' during a search, but file transfers are not
  30. hampered.
  31.  
  32. The File Search Engine accepts and replies to incoming netmail search requests! At this time,
  33. FidoConnect is the only supported import/export utility - the engine looks for "Originating node:
  34. #:###/###@fidonet" in the incoming search request, and delivers an answer to a folder called
  35. "netmail" which is in the same root path as the incoming request folder (called "search", "nodelist"
  36. or "bible").
  37.  
  38. Replies to online and netmail-based search requests are limited to about 400 lines, to comply with
  39. FidoNet restrictions.  Users searching for words that get high hit-levels like the word 'the' will be
  40. sent a message at the 400 line mark, asking them to be more specific in their next request.
  41.  
  42. New in version 1.3 of the Engine are two special commands available by sending a request to a user
  43. you create, called "911".  E-mail commands with a subject of "restart", "shutdown", "help" and "page"
  44. are honored.  Restart and shutdown execute the standard Mac shutdown sequence, while the help and
  45. page commands simply play a sound with a resource name of "911" installed in the application.  I use
  46. the restart/shutdown commmand (my Mac II has the reset switch set to restart when it performs the
  47. shutdown) to restart the BBS from remote, and the help/page command to get my wife's attention at
  48. home if I want her to break in and chat if I come online <grin>.  To block any user from using these
  49. commands, just place a file called "File Search.911" in your Tabby folder, and place names of users
  50. allowed to use the utility in it - one on a line.  An example file is supplied.
  51.  
  52. When not processing a request, the engine simply gives up idle time to other applications.
  53.  
  54.  
  55. How to Set the File Search Engine up...
  56. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  57. I purposely named the utility •File Search Engine so that it will appear last in your system's
  58. running application list.  Outside of an About box, the engine has no online configurations and can
  59. be quit from the File menu.
  60.  
  61. The engine looks for a file called "AllFiles.Header" (needed by Itsy SitC Citer as well) whose first
  62. line is the path to your BBS's file and description listing. It also requires a file called "File
  63. Search.Mail" which contains the path and name of the Mail folder which users will send search
  64. requests to.  If you want to provide online Bible searches to your users, a mail folder named "Bible"
  65. must exist, as well as a file in your Tabby folder called "File Search.Bible" which contains a line
  66. describing the full path & name of the Webster's Bible on one of your disks.  The name of the file
  67. description search folder is flexible - I use the user name "Search", but you can use anything.
  68. Configure the search account just like the FidoConnect docs state for the "netmail" account - and
  69. yes, File Search Engine requires the netmail account to be named exactly that.  The engine
  70. automatically looks for incoming search requests in the "nodelist" folder (if it exists) and will
  71. search the current nodelist, which must be present in the same folder as the •File Search Engine.
  72. The nodelist search does not require a setup file in the Tabby folder.  The "netmail", "Bible",
  73. "nodelist" and "search" mail folders MUST have the same root path.  All of File Search Engine's
  74. support files are located in the Tabby folder.  I've included my setup files as examples.
  75.  
  76. The engine checks for incoming requests every 5 seconds.  On my IIci, I have all the mail folders on
  77. a hard disk and have never seen disk access due solely to this scan.  If you notice a problem on your
  78. system, you may consider a small RAM disk specifically for the "netmail", "Bible", "nodelist" and
  79. "Search" accounts only.  Depending on your user's love for netmail, a 100k RAM disk should be way
  80. more than necessary.  Incoming search requests should be less than 3k.
  81.  
  82. If an improperly formatted request arrives in the Search folder, the engine will delete it.  The
  83. engine will sequentially process as many requests as your users throw at it.
  84.  
  85.  
  86. How Your Users Execute a Search...
  87. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  88. To use it, send a message to "search" or "Bible" with two search words or phrases - one in the Subject field, and one in the first line of the message.  Extra lines in the message are ignored (past the first).
  89.  
  90. Example
  91. ~~~~~~~
  92. To:      Search
  93. Subject: research
  94. _____________________________
  95. researcher deluxe
  96.  
  97.  
  98. The result of the search is sent to users via e-mail and looks like:
  99.  
  100. The following files matched the two key words (research,researcher deluxe) you submitted...
  101.  
  102. Directory: Educational...
  103. File Name: K12_INFO.ZIP                                     Size: 23253 
  104. Info on the K12 echo, which is an educator's echo
  105. for research, and for young people to chat international
  106. with others.
  107.  
  108. ______________________________________________________________________________
  109. This File Search Engine is courtesy of The Association Mac BBS @ 810-695-6955.
  110. We receive roughly 5Mb of new Mac files weekly, so drop in and visit sometime!
  111. ______________________________________________________________________________
  112.  
  113.  
  114. ...in the case of Bible searches, the request is formatted exactly the same, except addressed to "Bible".  The reply will look like this:
  115.  
  116. The following Bible verses matched the two key words (bronze,diamond) you submitted...
  117.  
  118. Book: EXODUS
  119. 28:18 a diamond.
  120. Book: EXODUS
  121. 39:11 And the second row, an emerald, a sapphire, and a diamond.
  122. Book: EZEKIEL
  123. 28:13 stone [was] thy covering, the sardius, topaz, and the diamond,
  124. Book: JEREMIAH
  125. 17:1 with the point of a diamond: [it is] graven upon the table of
  126.  
  127. ______________________________________________________________________________
  128. This Bible Search Engine is courtesy of The Association Mac BBS @ 810-695-6955.
  129. May God bless you as you search through the scripture for His wisdom and truth!
  130. ______________________________________________________________________________
  131.  
  132.  
  133.  
  134. The Webster's Bible is (obviously) not included in this archive for ease of
  135. distribution and because this feature of the File Search Engine is optional.
  136. If you don't wish to provide Bible searches to your users, simply don't include
  137. the "File Search.Bible" file in your Tabby folder.  If you *do* want to provide
  138. this feature, you can download or FREQ a specially concantenated version of 
  139. this Bible (the books are in alphabetical order in one file) as: 
  140.  
  141. Webster's Bible.sit
  142.  
  143.  
  144. The file is 1.5Mb in compressed format, and expands to just over 4Mb on disk.
  145. No other versions of the Bible will work correctly with the File Search Engine
  146. to list verses, books, and chapters properly with each matched verse.
  147.  
  148.  
  149.  
  150. ...in the case of nodelist searches, the request is formatted exactly the same, except addressed to "nodelist".  The reply will look like this:
  151.  
  152. The following NodeList entries matched the two key words (association,rich_fowler) you submitted...
  153.  
  154. 2240/130,Fellowship_Hall,Grand_Blanc_MI,Rich_Fowler,1-810-694-2608,9600,CM,XA,V32b,V42b
  155.  
  156. 2240/174,Association_Mac_BBS_II,Grand_Blanc_MI,Glen_Stewart,1-810-695-6955,9600,CM,XW,H14,V32b,V42b
  157.  
  158. Pvt 2240/175,Association_Mac_BBS_I,Grand_Blanc_MI,Glen_Stewart,-Unpublished-,9600,CM,XW,V32,HST
  159.  
  160. [etc. etc.]
  161. ______________________________________________________________________________
  162. This NodeList Search Engine is courtesy of The Association BBS @ 810-695-6955.
  163. We receive roughly 5Mb of new Mac files weekly, so drop in and visit sometime!
  164. ______________________________________________________________________________
  165.  
  166.  
  167. Enjoy the Search Engine!
  168.  
  169. Glen Stewart